
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta content="text/javascript" http-equiv="content-script-type">
<title>form</title>
<link rel="stylesheet" type="text/css" href="candydoc/style.css">
<!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="candydoc/ie56hack.css"><![endif]-->
<script language="JavaScript" src="candydoc/util.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/tree.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/explorer.js" type="text/javascript"></script>
</head><body>
<div id="tabarea"></div><div id="explorerclient"></div>
<div id="content"><script>explorer.initialize("form");</script>
	<table class="content">
		<tr><td id="docbody"><h1>form</h1><!-- Generated by Ddoc from ../modules/form.d -->
<b>Authors:</b><br>
Jon "ylixir" Allen, ylixir@gmail.com
<br><br>
<b>License:</b><br>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
<br><br>

    The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
<br><br>

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
<br><br>


<script>explorer.outline.incSymbolLevel();</script>
<dl>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">pos_form_cursor</span>
<script>explorer.outline.addDecl('pos_form_cursor');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Restores the cursor to the position required by the forms driver.
<br><br>
<b>See Also:</b><br>
man form_cursor
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">bool 
<span class="currsymbol">data_ahead</span>
<script>explorer.outline.addDecl('data_ahead');</script>

(FORM* <span class="funcparam">form</span>);
<br>bool 
<span class="currsymbol">data_behind</span>
<script>explorer.outline.addDecl('data_behind');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Check and see if there is offscreen data ahead/behind in the <span class="funcparam">form</span>.
<br><br>
<b>See Also:</b><br>
man form_data
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">form_driver</span>
<script>explorer.outline.addDecl('form_driver');</script>

(FORM* <span class="funcparam">form</span>, int <span class="funcparam">c</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Routine to funnel input events for the <span class="funcparam">form</span> though.
<br><br>
<b>See Also:</b><br>
man 
<span class="currsymbol">form_driver</span>
<script>explorer.outline.addDecl('form_driver');</script>


<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_PAGE</span>
<script>explorer.outline.addDecl('REQ_NEXT_PAGE');</script>

<br>
<span class="currsymbol">REQ_PREV_PAGE</span>
<script>explorer.outline.addDecl('REQ_PREV_PAGE');</script>

<br>
<span class="currsymbol">REQ_FIRST_PAGE</span>
<script>explorer.outline.addDecl('REQ_FIRST_PAGE');</script>

<br>
<span class="currsymbol">REQ_LAST_PAGE</span>
<script>explorer.outline.addDecl('REQ_LAST_PAGE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to the given page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_FIELD</span>
<script>explorer.outline.addDecl('REQ_NEXT_FIELD');</script>

<br>
<span class="currsymbol">REQ_PREV_FIELD</span>
<script>explorer.outline.addDecl('REQ_PREV_FIELD');</script>

<br>
<span class="currsymbol">REQ_FIRST_FIELD</span>
<script>explorer.outline.addDecl('REQ_FIRST_FIELD');</script>

<br>
<span class="currsymbol">REQ_LAST_FIELD</span>
<script>explorer.outline.addDecl('REQ_LAST_FIELD');</script>

<br>
<span class="currsymbol">REQ_SNEXT_FIELD</span>
<script>explorer.outline.addDecl('REQ_SNEXT_FIELD');</script>

<br>
<span class="currsymbol">REQ_SPREV_FIELD</span>
<script>explorer.outline.addDecl('REQ_SPREV_FIELD');</script>

<br>
<span class="currsymbol">REQ_SFIRST_FIELD</span>
<script>explorer.outline.addDecl('REQ_SFIRST_FIELD');</script>

<br>
<span class="currsymbol">REQ_SLAST_FIELD</span>
<script>explorer.outline.addDecl('REQ_SLAST_FIELD');</script>

<br>
<span class="currsymbol">REQ_LEFT_FIELD</span>
<script>explorer.outline.addDecl('REQ_LEFT_FIELD');</script>

<br>
<span class="currsymbol">REQ_RIGHT_FIELD</span>
<script>explorer.outline.addDecl('REQ_RIGHT_FIELD');</script>

<br>
<span class="currsymbol">REQ_UP_FIELD</span>
<script>explorer.outline.addDecl('REQ_UP_FIELD');</script>

<br>
<span class="currsymbol">REQ_DOWN_FIELD</span>
<script>explorer.outline.addDecl('REQ_DOWN_FIELD');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to the specified field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_CHAR</span>
<script>explorer.outline.addDecl('REQ_NEXT_CHAR');</script>

<br>
<span class="currsymbol">REQ_PREV_CHAR</span>
<script>explorer.outline.addDecl('REQ_PREV_CHAR');</script>

<br>
<span class="currsymbol">REQ_NEXT_LINE</span>
<script>explorer.outline.addDecl('REQ_NEXT_LINE');</script>

<br>
<span class="currsymbol">REQ_PREV_LINE</span>
<script>explorer.outline.addDecl('REQ_PREV_LINE');</script>

<br>
<span class="currsymbol">REQ_NEXT_WORD</span>
<script>explorer.outline.addDecl('REQ_NEXT_WORD');</script>

<br>
<span class="currsymbol">REQ_PREV_WORD</span>
<script>explorer.outline.addDecl('REQ_PREV_WORD');</script>

<br>
<span class="currsymbol">REQ_BEG_FIELD</span>
<script>explorer.outline.addDecl('REQ_BEG_FIELD');</script>

<br>
<span class="currsymbol">REQ_END_FIELD</span>
<script>explorer.outline.addDecl('REQ_END_FIELD');</script>

<br>
<span class="currsymbol">REQ_BEG_LINE</span>
<script>explorer.outline.addDecl('REQ_BEG_LINE');</script>

<br>
<span class="currsymbol">REQ_END_LINE</span>
<script>explorer.outline.addDecl('REQ_END_LINE');</script>

<br>
<span class="currsymbol">REQ_LEFT_CHAR</span>
<script>explorer.outline.addDecl('REQ_LEFT_CHAR');</script>

<br>
<span class="currsymbol">REQ_RIGHT_CHAR</span>
<script>explorer.outline.addDecl('REQ_RIGHT_CHAR');</script>

<br>
<span class="currsymbol">REQ_UP_CHAR</span>
<script>explorer.outline.addDecl('REQ_UP_CHAR');</script>

<br>
<span class="currsymbol">REQ_DOWN_CHAR</span>
<script>explorer.outline.addDecl('REQ_DOWN_CHAR');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to the specified place
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEW_LINE</span>
<script>explorer.outline.addDecl('REQ_NEW_LINE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>insert/overlay a new line
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_INS_CHAR</span>
<script>explorer.outline.addDecl('REQ_INS_CHAR');</script>

<br>
<span class="currsymbol">REQ_INS_LINE</span>
<script>explorer.outline.addDecl('REQ_INS_LINE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>insert a blank char/line at the cursor
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_DEL_CHAR</span>
<script>explorer.outline.addDecl('REQ_DEL_CHAR');</script>

<br>
<span class="currsymbol">REQ_DEL_PREV</span>
<script>explorer.outline.addDecl('REQ_DEL_PREV');</script>

<br>
<span class="currsymbol">REQ_DEL_LINE</span>
<script>explorer.outline.addDecl('REQ_DEL_LINE');</script>

<br>
<span class="currsymbol">REQ_DEL_WORD</span>
<script>explorer.outline.addDecl('REQ_DEL_WORD');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>delete the specified item
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_CLR_EOL</span>
<script>explorer.outline.addDecl('REQ_CLR_EOL');</script>

<br>
<span class="currsymbol">REQ_CLR_EOF</span>
<script>explorer.outline.addDecl('REQ_CLR_EOF');</script>

<br>
<span class="currsymbol">REQ_CLR_FIELD</span>
<script>explorer.outline.addDecl('REQ_CLR_FIELD');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>clear as specified
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_OVL_MODE</span>
<script>explorer.outline.addDecl('REQ_OVL_MODE');</script>

<br>
<span class="currsymbol">REQ_INS_MODE</span>
<script>explorer.outline.addDecl('REQ_INS_MODE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>enter the specified mode
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_SCR_FLINE</span>
<script>explorer.outline.addDecl('REQ_SCR_FLINE');</script>

<br>
<span class="currsymbol">REQ_SCR_BLINE</span>
<script>explorer.outline.addDecl('REQ_SCR_BLINE');</script>

<br>
<span class="currsymbol">REQ_SCR_FPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_FPAGE');</script>

<br>
<span class="currsymbol">REQ_SCR_BPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_BPAGE');</script>

<br>
<span class="currsymbol">REQ_SCR_FHPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_FHPAGE');</script>

<br>
<span class="currsymbol">REQ_SCR_BHPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_BHPAGE');</script>

<br>
<span class="currsymbol">REQ_SCR_FCHAR</span>
<script>explorer.outline.addDecl('REQ_SCR_FCHAR');</script>

<br>
<span class="currsymbol">REQ_SCR_BCHAR</span>
<script>explorer.outline.addDecl('REQ_SCR_BCHAR');</script>

<br>
<span class="currsymbol">REQ_SCR_HFLINE</span>
<script>explorer.outline.addDecl('REQ_SCR_HFLINE');</script>

<br>
<span class="currsymbol">REQ_SCR_HBLINE</span>
<script>explorer.outline.addDecl('REQ_SCR_HBLINE');</script>

<br>
<span class="currsymbol">REQ_SCR_HFHALF</span>
<script>explorer.outline.addDecl('REQ_SCR_HFHALF');</script>

<br>
<span class="currsymbol">REQ_SCR_HBHALF</span>
<script>explorer.outline.addDecl('REQ_SCR_HBHALF');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>scroll the given amount
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_VALIDATION</span>
<script>explorer.outline.addDecl('REQ_VALIDATION');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>validate a field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_CHOICE</span>
<script>explorer.outline.addDecl('REQ_NEXT_CHOICE');</script>

<br>
<span class="currsymbol">REQ_PREV_CHOICE</span>
<script>explorer.outline.addDecl('REQ_PREV_CHOICE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>display next/previous choice
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_fields</span>
<script>explorer.outline.addDecl('set_form_fields');</script>

(FORM* <span class="funcparam">form</span>, FIELD** <span class="funcparam">fields</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set the <span class="funcparam">fields</span> in the <span class="funcparam">form</span> to the given <b>null</b> terminated array
<br><br>
<b>See Also:</b><br>
man form_field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELD** 
<span class="currsymbol">form_fields</span>
<script>explorer.outline.addDecl('form_fields');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the array of fields in the <span class="funcparam">form</span>.
<br><br>
<b>See Also:</b><br>
man form_field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">field_count</span>
<script>explorer.outline.addDecl('field_count');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Find out how many fields are in the <span class="funcparam">form</span>.
<br><br>
<b>See Also:</b><br>
man form_field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">move_field</span>
<script>explorer.outline.addDecl('move_field');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">frow</span>, int <span class="funcparam">fcol</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Move the <span class="funcparam">field</span> to the specified place on the screen.
<br><br>
<b>See Also:</b><br>
man form_field
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">field_info</span>
<script>explorer.outline.addDecl('field_info');</script>

(FIELD* <span class="funcparam">field</span>, int* <span class="funcparam">rows</span>, int* <span class="funcparam">cols</span>, int* <span class="funcparam">frow</span>, int* <span class="funcparam">fcol</span>, int* <span class="funcparam">nrow</span>, int* <span class="funcparam">nbuf</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the attributes passed to a <span class="funcparam">field</span> when it was created.
<br><br>
<b>See Also:</b><br>
man form_field_info
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">dynamic_field_info</span>
<script>explorer.outline.addDecl('dynamic_field_info');</script>

(FIELD* <span class="funcparam">field</span>, int* <span class="funcparam">rows</span>, int* <span class="funcparam">cols</span>, int* <span class="funcparam">max</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the actual attributes of a <span class="funcparam">field</span>.
<br><br>
<b>See Also:</b><br>
man form_field_info
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELD* 
<span class="currsymbol">new_field</span>
<script>explorer.outline.addDecl('new_field');</script>

(int <span class="funcparam">height</span>, int <span class="funcparam">width</span>, int <span class="funcparam">toprow</span>, int <span class="funcparam">leftcol</span>, int <span class="funcparam">offscreen</span>, int <span class="funcparam">nbuffers</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Allocate and initialize a new field.
<br><br>
<b>See Also:</b><br>
man form_field_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELD* 
<span class="currsymbol">dup_field</span>
<script>explorer.outline.addDecl('dup_field');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">toprow</span>, int <span class="funcparam">leftcol</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Duplicate an existing <span class="funcparam">field</span>
<br><br>
<b>See Also:</b><br>
man form_field_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELD* 
<span class="currsymbol">link_field</span>
<script>explorer.outline.addDecl('link_field');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">toprow</span>, int <span class="funcparam">leftcol</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Duplicate a <span class="funcparam">field</span>, but share buffers with the original <span class="funcparam">field</span>.
<br><br>
<b>See Also:</b><br>
man form_field_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">free_field</span>
<script>explorer.outline.addDecl('free_field');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Deallocate a <span class="funcparam">field</span>.
<br><br>
<b>See Also:</b><br>
man form_field_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_fore</span>
<script>explorer.outline.addDecl('set_field_fore');</script>

(FIELD* <span class="funcparam">field</span>, uint <span class="funcparam">attr</span>);
<br>uint 
<span class="currsymbol">field_fore</span>
<script>explorer.outline.addDecl('field_fore');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a fields foreground attributes.
<br><br>
<b>See Also:</b><br>
man form_field_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_back</span>
<script>explorer.outline.addDecl('set_field_back');</script>

(FIELD* <span class="funcparam">field</span>, uint <span class="funcparam">attr</span>);
<br>uint 
<span class="currsymbol">field_back</span>
<script>explorer.outline.addDecl('field_back');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a fields background attributes.
<br><br>
<b>See Also:</b><br>
man form_field_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_pad</span>
<script>explorer.outline.addDecl('set_field_pad');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">pad</span>);
<br>int 
<span class="currsymbol">field_pad</span>
<script>explorer.outline.addDecl('field_pad');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a fields padding character attributes.
<br><br>
<b>See Also:</b><br>
man form_field_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_buffer</span>
<script>explorer.outline.addDecl('set_field_buffer');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">buf</span>, char* <span class="funcparam">value</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set the buffer of a <span class="funcparam">field</span> to contain a given string
<br><br>
<b>See Also:</b><br>
man form_field_buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">char* 
<span class="currsymbol">field_buffer</span>
<script>explorer.outline.addDecl('field_buffer');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">buffer</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get a pointer to a fields <span class="funcparam">buffer</span>
<br><br>
<b>See Also:</b><br>
man form_field_buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_status</span>
<script>explorer.outline.addDecl('set_field_status');</script>

(FIELD* <span class="funcparam">field</span>, bool <span class="funcparam">status</span>);
<br>bool 
<span class="currsymbol">field_status</span>
<script>explorer.outline.addDecl('field_status');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set a fields <span class="funcparam">status</span>.  True if changed.
<br><br>
<b>See Also:</b><br>
man form_field_buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_max_field</span>
<script>explorer.outline.addDecl('set_max_field');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">max</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set the <span class="funcparam">max</span> size of a dynamic <span class="funcparam">field</span>.
<br><br>
<b>See Also:</b><br>
man form_field_buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_just</span>
<script>explorer.outline.addDecl('set_field_just');</script>

(FIELD* <span class="funcparam">field</span>, int <span class="funcparam">justification</span>);
<br>int 
<span class="currsymbol">field_just</span>
<script>explorer.outline.addDecl('field_just');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set a fields <span class="funcparam">justification</span>.
<br><br>
<b>See Also:</b><br>
man form_field_just
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">NO_JUSTIFICATION</span>
<script>explorer.outline.addDecl('NO_JUSTIFICATION');</script>

<br>
<span class="currsymbol">JUSTIFY_LEFT</span>
<script>explorer.outline.addDecl('JUSTIFY_LEFT');</script>

<br>
<span class="currsymbol">JUSTIFY_CENTER</span>
<script>explorer.outline.addDecl('JUSTIFY_CENTER');</script>

<br>
<span class="currsymbol">JUSTIFY_RIGHT</span>
<script>explorer.outline.addDecl('JUSTIFY_RIGHT');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Justification constants
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_opts</span>
<script>explorer.outline.addDecl('set_field_opts');</script>

(FIELD* <span class="funcparam">field</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set all of a fields option bits.
<br><br>
<b>See Also:</b><br>
man form_field_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">field_opts_on</span>
<script>explorer.outline.addDecl('field_opts_on');</script>

(FIELD* <span class="funcparam">field</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Turn on a fields given option bits.
<br><br>
<b>See Also:</b><br>
man form_field_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">field_opts_off</span>
<script>explorer.outline.addDecl('field_opts_off');</script>

(FIELD* <span class="funcparam">field</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Turn off a fields given option bits.
<br><br>
<b>See Also:</b><br>
man form_field_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">OPTIONS 
<span class="currsymbol">field_opts</span>
<script>explorer.outline.addDecl('field_opts');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get a fields option bits.
<br><br>
<b>See Also:</b><br>
man form_field_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_userptr</span>
<script>explorer.outline.addDecl('set_field_userptr');</script>

(FIELD* <span class="funcparam">field</span>, void* <span class="funcparam">userptr</span>);
<br>void* 
<span class="currsymbol">field_userptr</span>
<script>explorer.outline.addDecl('field_userptr');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set a fields application specific data.
<br><br>
<b>See Also:</b><br>
man form_field_userptr
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_type</span>
<script>explorer.outline.addDecl('set_field_type');</script>

(FIELD* <span class="funcparam">field</span>, FIELDTYPE* <span class="funcparam">type</span>,...);
<br>FIELDTYPE* 
<span class="currsymbol">field_type</span>
<script>explorer.outline.addDecl('field_type');</script>

(FIELD* <span class="funcparam">field</span>);
<br>void* 
<span class="currsymbol">field_arg</span>
<script>explorer.outline.addDecl('field_arg');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get a <span class="funcparam">field</span> <span class="funcparam">type</span>.
<br><br>
<b>See Also:</b><br>
man form_field_validation
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELDTYPE* 
<span class="currsymbol">TYPE_ALNUM</span>
<script>explorer.outline.addDecl('TYPE_ALNUM');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_ALPHA</span>
<script>explorer.outline.addDecl('TYPE_ALPHA');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_ENUM</span>
<script>explorer.outline.addDecl('TYPE_ENUM');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_INTEGER</span>
<script>explorer.outline.addDecl('TYPE_INTEGER');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_NUMERIC</span>
<script>explorer.outline.addDecl('TYPE_NUMERIC');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_REGEXP</span>
<script>explorer.outline.addDecl('TYPE_REGEXP');</script>

;
<br>FIELDTYPE* 
<span class="currsymbol">TYPE_IPV4</span>
<script>explorer.outline.addDecl('TYPE_IPV4');</script>

;
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Valid field types.
<br><br>
<b>See Also:</b><br>
man form_field_validation
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELDTYPE* 
<span class="currsymbol">new_fieldtype</span>
<script>explorer.outline.addDecl('new_fieldtype');</script>

(bool function(FIELD*, void*) <span class="funcparam">field_check</span>, bool function(int, void*) <span class="funcparam">char_check</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Create a new field type.
<br><br>
<b>See Also:</b><br>
man form_fieldtype
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">free_fieldtype</span>
<script>explorer.outline.addDecl('free_fieldtype');</script>

(FIELDTYPE* <span class="funcparam">fieldtype</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Free space allocated for a field type.
<br><br>
<b>See Also:</b><br>
man form_fieldtype
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_fieldtype_arg</span>
<script>explorer.outline.addDecl('set_fieldtype_arg');</script>

(FIELDTYPE* <span class="funcparam">fieldtype</span>, void* function(char**) <span class="funcparam">make_arg</span>, void* function(void*) <span class="funcparam">copy_arg</span>, void function(void*) <span class="funcparam">free_arg</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Associate storage management functions with a field type.
<br><br>
<b>See Also:</b><br>
man form_fieldtype
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_fieldtype_choice</span>
<script>explorer.outline.addDecl('set_fieldtype_choice');</script>

(FIELDTYPE* <span class="funcparam">fieldtype</span>, bool function(FIELD*, void*) <span class="funcparam">next_choice</span>, bool function(FIELD*, void*) <span class="funcparam">prev_choice</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Define successor and predecessor functions for the field type.
<br><br>
<b>See Also:</b><br>
man form_fieldtype
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FIELDTYPE* 
<span class="currsymbol">link_fieldtype</span>
<script>explorer.outline.addDecl('link_fieldtype');</script>

(FIELDTYPE* <span class="funcparam">type1</span>, FIELDTYPE* <span class="funcparam">type2</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Create a new field type from two other types.
<br><br>
<b>See Also:</b><br>
man form_fieldtype
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_init</span>
<script>explorer.outline.addDecl('set_field_init');</script>

(FORM* <span class="funcparam">form</span>, void function(FORM*) <span class="funcparam">func</span>);
<br>void function(FORM*) 
<span class="currsymbol">field_init</span>
<script>explorer.outline.addDecl('field_init');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a hook to be called at <span class="funcparam">form</span> post time and after a field changes.
<br><br>
<b>See Also:</b><br>
man form_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_field_term</span>
<script>explorer.outline.addDecl('set_field_term');</script>

(FORM* <span class="funcparam">form</span>, void function(FORM*) <span class="funcparam">func</span>);
<br>void function(FORM*) 
<span class="currsymbol">field_term</span>
<script>explorer.outline.addDecl('field_term');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a hook to be called at <span class="funcparam">form</span> unpost time and before a field change.
<br><br>
<b>See Also:</b><br>
man form_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_init</span>
<script>explorer.outline.addDecl('set_form_init');</script>

(FORM* <span class="funcparam">form</span>, void function(FORM*) <span class="funcparam">func</span>);
<br>void function(FORM*) 
<span class="currsymbol">form_init</span>
<script>explorer.outline.addDecl('form_init');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a hook to be called at <span class="funcparam">form</span> post time and after a page change.
<br><br>
<b>See Also:</b><br>
man form_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_term</span>
<script>explorer.outline.addDecl('set_form_term');</script>

(FORM* <span class="funcparam">form</span>, void function(FORM*) <span class="funcparam">func</span>);
<br>void function(FORM*) 
<span class="currsymbol">form_term</span>
<script>explorer.outline.addDecl('form_term');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets a hook to be called at <span class="funcparam">form</span> unpost time and before a page change.
<br><br>
<b>See Also:</b><br>
man form_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">FORM* 
<span class="currsymbol">new_form</span>
<script>explorer.outline.addDecl('new_form');</script>

(FIELD** <span class="funcparam">fields</span>);
<br>int 
<span class="currsymbol">free_form</span>
<script>explorer.outline.addDecl('free_form');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Create/destroy a new form.
<br><br>
<b>See Also:</b><br>
man form_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_new_page</span>
<script>explorer.outline.addDecl('set_new_page');</script>

(FIELD* <span class="funcparam">field</span>, bool <span class="funcparam">new_page_flag</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set a <span class="funcparam">field</span> to be the beginning of a new page.
<br><br>
<b>See Also:</b><br>
man form_new_page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">bool 
<span class="currsymbol">new_page</span>
<script>explorer.outline.addDecl('new_page');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Check if a <span class="funcparam">field</span> is the beginning of a new page.
<br><br>
<b>See Also:</b><br>
man form_new_page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_opts</span>
<script>explorer.outline.addDecl('set_form_opts');</script>

(FORM* <span class="funcparam">form</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set all of a forms option bits.
<br><br>
<b>See Also:</b><br>
man form_form_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">form_opts_on</span>
<script>explorer.outline.addDecl('form_opts_on');</script>

(FORM* <span class="funcparam">form</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Turn on a forms given option bits.
<br><br>
<b>See Also:</b><br>
man form_form_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">form_opts_off</span>
<script>explorer.outline.addDecl('form_opts_off');</script>

(FORM* <span class="funcparam">form</span>, OPTIONS <span class="funcparam">opts</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Turn off a forms given option bits.
<br><br>
<b>See Also:</b><br>
man form_form_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">OPTIONS 
<span class="currsymbol">form_opts</span>
<script>explorer.outline.addDecl('form_opts');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get a forms option bits.
<br><br>
<b>See Also:</b><br>
man form_form_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_current_field</span>
<script>explorer.outline.addDecl('set_current_field');</script>

(FORM* <span class="funcparam">form</span>, FIELD* <span class="funcparam">field</span>);
<br>FIELD* 
<span class="currsymbol">current_field</span>
<script>explorer.outline.addDecl('current_field');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the forms current <span class="funcparam">field</span>.
<br><br>
<b>See Also:</b><br>
man form_page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_page</span>
<script>explorer.outline.addDecl('set_form_page');</script>

(FORM* <span class="funcparam">form</span>, int <span class="funcparam">n</span>);
<br>int 
<span class="currsymbol">form_page</span>
<script>explorer.outline.addDecl('form_page');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the forms current page.
<br><br>
<b>See Also:</b><br>
man form_page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">field_index</span>
<script>explorer.outline.addDecl('field_index');</script>

(FIELD* <span class="funcparam">field</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get a fields index in its form.
<br><br>
<b>See Also:</b><br>
man form_page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">post_form</span>
<script>explorer.outline.addDecl('post_form');</script>

(FORM* <span class="funcparam">form</span>);
<br>int 
<span class="currsymbol">unpost_form</span>
<script>explorer.outline.addDecl('unpost_form');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Display/erase a <span class="funcparam">form</span>
<br><br>
<b>See Also:</b><br>
man form_post
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">char* 
<span class="currsymbol">form_request_name</span>
<script>explorer.outline.addDecl('form_request_name');</script>

(int <span class="funcparam">request</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the printable name of a form <span class="funcparam">request</span> code
<br><br>
<b>See Also:</b><br>
man form_requestname
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">form_request_by_name</span>
<script>explorer.outline.addDecl('form_request_by_name');</script>

(char* <span class="funcparam">name</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Search for a request code by it's printable <span class="funcparam">name</span>
<br><br>
<b>See Also:</b><br>
man form_requestname
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_win</span>
<script>explorer.outline.addDecl('set_form_win');</script>

(FORM* <span class="funcparam">form</span>, WINDOW* <span class="funcparam">win</span>);
<br>WINDOW* 
<span class="currsymbol">form_win</span>
<script>explorer.outline.addDecl('form_win');</script>

(FORM* <span class="funcparam">form</span>);
<br>int 
<span class="currsymbol">set_form_sub</span>
<script>explorer.outline.addDecl('set_form_sub');</script>

(FORM* <span class="funcparam">form</span>, WINDOW* <span class="funcparam">sub</span>);
<br>WINDOW* 
<span class="currsymbol">form_sub</span>
<script>explorer.outline.addDecl('form_sub');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/remove <span class="funcparam">form</span> window associations.
<br><br>
<b>See Also:</b><br>
man form_win
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">scale_form</span>
<script>explorer.outline.addDecl('scale_form');</script>

(FORM* <span class="funcparam">form</span>, int* <span class="funcparam">rows</span>, int* <span class="funcparam">columns</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the minimum size required for a forms subwindow
<br><br>
<b>See Also:</b><br>
man form_win
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_form_userptr</span>
<script>explorer.outline.addDecl('set_form_userptr');</script>

(FORM* <span class="funcparam">form</span>, void* <span class="funcparam">userptr</span>);
<br>void* 
<span class="currsymbol">form_userptr</span>
<script>explorer.outline.addDecl('form_userptr');</script>

(FORM* <span class="funcparam">form</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set a forms application specific data.
<br><br>
<b>See Also:</b><br>
man form_field_userptr
<br><br>

</dd>
</dl>
<script>explorer.outline.decSymbolLevel();</script>


</td></tr>
		<tr><td id="docfooter">
			Page was generated with
			<img src="candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
			on Sat Oct 25 15:39:19 2008

		</td></tr>
	</table>
</div>
<script></script>
</body></html>


